/**
 * Copyright 2012 Roger Cockshutt
 * krakenbrau@gmail.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.googlecode.libspml;

/**
 * @author Roger Cockshutt
 *
 * Instances of Classes implementing the ISemanticSyntaxNode interface are nodes of ISemanticSyntaxTrees.
 */
public abstract class AbstractSemanticSyntaxNode {
	
	protected final ISemanticSyntaxTreeProvider.SemanticSymbol symbol_;
	protected final java.util.List<AbstractSemanticSyntaxNode> subNodes_;
	protected final boolean isTerminal_;
	protected final String value_;
	
	
	
	public AbstractSemanticSyntaxNode(ISemanticSyntaxTreeProvider.SemanticSymbol symbol, boolean terminal, String value) {
		this.symbol_ = symbol;
		this.isTerminal_ = terminal;
		this.subNodes_ = new java.util.Vector<AbstractSemanticSyntaxNode>();
		this.value_ = value;
	}
	
	
	
	public String getValue() {
		return value_;
	}
	
	
	
	/**
	 * @return The Symbol represented by this node.
	 */
	public ISemanticSyntaxTreeProvider.SemanticSymbol getSymbol() {
		return symbol_;
	}
	
	
	
	/**
	 * @param node The node to be added as a sub node.
	 * @return true if the node was added, false if not.  Terminal nodes cannot have subnodes.
	 */
	public boolean addSubNode(AbstractSemanticSyntaxNode node) {
		if (!isTerminal_) {
			subNodes_.add(node);
			return true;
		}
		return false;
	}
	
	
	
	/**
	 * @return A List containing the sub nodes of this node.
	 */
	public java.util.List<AbstractSemanticSyntaxNode> getSubNodes() {
		return new java.util.Vector<AbstractSemanticSyntaxNode>(subNodes_);
	}
	
	
	
	/**
	 * @return true if this is a terminal node (has no sub nodes), false otherwise.
	 */
	public boolean isTerminal() {
		return isTerminal_;
	}

}
